Skip to content

docs: consolidate design + decisions into docs/DESIGN.md, slim READMEs#11

Merged
aksOps merged 1 commit into
mainfrom
docs/consolidate-design-and-decisions
May 14, 2026
Merged

docs: consolidate design + decisions into docs/DESIGN.md, slim READMEs#11
aksOps merged 1 commit into
mainfrom
docs/consolidate-design-and-decisions

Conversation

@aksOps

@aksOps aksOps commented May 14, 2026

Copy link
Copy Markdown
Contributor

Summary

Single canonical document for new contributors and operators. Cleans up stale documentation across the repo.

What landed

docs/DESIGN.md (new, ~600 lines)

The consolidated design document. Sixteen sections:

  1. What it is
  2. Architecture at a glance (layered diagram + control flow)
  3. Core abstractions (Session, Skill, AgentRun, ToolCall, Orchestrator, Gateway, AgentTurnOutput)
  4. Runtime model (lifecycle, dispatch, routing, termination)
  5. LLM provider story (per-agent override, 429 retry, live verification)
  6. Markdown turn-output contract — the 7 parse paths + gpt-oss quirks
  7. HITL approve/reject — langgraph 1.x __interrupt__ semantics + the five PR fix(hitl): HITL approve/reject end-to-end + gpt-oss markdown reliability #6 fixes
  8. Storage (SessionStore, IncidentRow, HistoryStore, langgraph checkpointer, EventLog)
  9. Memory layers (incident_management example)
  10. Deployment (single-file bundle, 7-file payload, air-gap)
  11. Telemetry + auto-learning (M1–M9)
  12. Decision log — 12 numbered DEC-NNN entries with rationale
  13. Milestone history — v1.0 → v1.5
  14. Pending / known gaps
  15. Where to find what
  16. Document map

README.md (new, repo root)

Repo had no top-level README. One-screen overview pointing at the three docs (DESIGN.md, DEVELOPMENT.md, AIRGAP_INSTALL.md). Quickstart commands. Status block.

Slimmed example READMEs

  • examples/incident_management/README.md: ~230 → ~80 lines. Removed framework-wide content (Phase 4/5/6/8/9 narrative, agent kinds, trigger registry, ratchet) — all in DESIGN now. App-specific layout / domain shape / MCP tools / ASR memory layers stay.
  • examples/code_review/README.md: ~120 → ~70 lines. Same treatment.

Deleted stale committed artifacts

  • .planning/phases/01-concurrency-foundation/01-01-SUMMARY.md
  • .planning/phases/14-reproducible-air-gap-lockfile/14-01-PLAN.md, 14-01-SUMMARY.md, 14-VERIFICATION.md

Their content is superseded by DESIGN § 13 (milestone history) + § 12 (decision log). The .planning/ directory is gitignored per-convention; these were committed before that convention applied.

.gitignore

Explicitly track docs/DESIGN.md next to the other two committed docs.

Unchanged

docs/DEVELOPMENT.md and docs/AIRGAP_INSTALL.md are operational how-tos (regenerate dist, install behind a mirror) rather than design content, and remain accurate.

Test plan

  • uv run ruff check src/ tests/ — clean
  • uv run pytest -x1265 passed, 8 skipped (unchanged — docs-only)
  • No source changes

🤖 Generated with Claude Code

Single canonical document for new contributors and operators. Cleans
up stale documentation and replaces it with a coherent architecture
+ decision-log narrative.

What landed:

* **`docs/DESIGN.md`** (new, ~600 lines) — the consolidated design
  document. Sixteen sections covering: what the framework is, the
  layered architecture (LangGraph + LangChain + FastMCP +
  framework + app), core abstractions (Session, Skill, AgentRun,
  ToolCall, Orchestrator, Gateway, AgentTurnOutput), runtime model
  (lifecycle, dispatch, routing, termination), LLM provider story
  (per-agent override, 429 retry, live verification), markdown
  turn-output contract (the 7 parse paths + gpt-oss quirks), HITL
  approve/reject (langgraph 1.x __interrupt__ semantics + the five
  PR #6 fixes), storage, telemetry, deployment, decision log
  (12 numbered DEC-NNN entries with rationale), milestone history
  (v1.0–v1.5), pending list, and a "where to find what" map.

* **`README.md`** (new, repo root) — short overview pointing at
  docs/DESIGN.md as the canonical entry. Quickstart commands, two
  example apps named, document map.

* **`examples/incident_management/README.md`** — slimmed from
  ~230 lines to ~80. Removed framework-wide content (Phase 4/5/6/8/9
  narrative, agent kinds explainer, trigger registry walkthrough,
  genericity ratchet description) — all of that lives in
  docs/DESIGN.md now. App README focuses on the layout, domain
  shape, MCP tools, ASR memory layers.

* **`examples/code_review/README.md`** — slimmed from ~120 lines to
  ~70. Same treatment: framework explainer text moved to DESIGN,
  README focuses on app-specific details.

* **`.gitignore`** — explicitly track `docs/DESIGN.md` next to the
  other two committed docs (`AIRGAP_INSTALL.md`, `DEVELOPMENT.md`).
  The `docs/*` blanket ignore stays so accidentally-generated scratch
  doesn't leak in.

* Deleted four committed `.planning/phases/*` artifacts (Phase 01
  summary, Phase 14 plan / summary / verification). Their content is
  superseded by docs/DESIGN.md § 13 (milestone history) and § 12
  (decision log). The `.planning/` directory is gitignored
  per-convention; these were committed before that convention
  applied.

`docs/DEVELOPMENT.md` and `docs/AIRGAP_INSTALL.md` are unchanged —
they're operational how-tos (regenerate dist, install behind a
mirror) rather than design content, and remain accurate.

Suite: 1265 passed (unchanged), ruff clean. No source changes.
@sonarqubecloud

Copy link
Copy Markdown

@aksOps aksOps merged commit b97ddb3 into main May 14, 2026
8 checks passed
@aksOps aksOps deleted the docs/consolidate-design-and-decisions branch May 14, 2026 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant